Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix composable function typos. Clarify wording. #3252

Merged
merged 7 commits into from
Mar 19, 2021
Merged

Conversation

manzaloros
Copy link
Contributor

@manzaloros manzaloros commented Mar 18, 2021

Summary of changes:

  1. Fix small typos and wording for composable functions description.

Checklist — To help your pull request get merged faster, please do the following:

    • Provide a summary of your changes — say what problem you are fixing, what files are changed, and what you've done. This doesn't need to be hugely detailed, as we can see exact changes in the "Files changed" tab.
    • Provide a link to the issue(s) you are fixing, if appropriate, in the form "Fixes url-of-issue". GitHub will render this in the form "Fixes fix: fixable flaws in Glossary A-D entries #1234", with the issue number linked to the issue. Doing this allows us to figure out what issues you are fixing, as well as helping to automate things (for example the issue will be closed once the PR that fixed it has been merged).
    • Review the results of the automated checking we run on every PR and fix any problems reported (see the list of checks near the bottom of the PR page). If you need help, please ask in a comment!
    • Link to any other resources that you think might be useful in reviewing your PR.

@manzaloros manzaloros requested a review from a team as a code owner March 18, 2021 01:54
@manzaloros manzaloros requested review from sideshowbarker and removed request for a team March 18, 2021 01:54
Copy link
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I agree that the current text here is very unclear. I had a couple of suggestions though - in particular I don't think technical writing should ever call something "simple" as a general judgement.

Copy link
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I pushed a couple of final changes:

  • we use sentence case "Defining composable functions" rather than title case "Defining Composable Functions"
  • removed the code comment and integrated the Wikipedia link

Thanks for your work on this PR @manzaloros , it's a real improvement to the docs!

@wbamberg wbamberg merged commit 28452dd into mdn:main Mar 19, 2021
@manzaloros
Copy link
Contributor Author

Thank you, @wbamberg , I appreciate your compliment and your help.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 21, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants